Add optional key to the FieldExport target #100

baijum · 2022-08-23T16:32:38Z

FieldExport generates the key name with an output structure like
<namespace>.<FieldExport-resource-name>. This default naming structure
creates non-conflicting names as the keys. However, many applications
expect short names as keys. This is important, especially when the
Secret/ConfigMap is mounted as files; the file names are nothing but
the key names.

This PR adds an optional attribute (.spec.to.key) to specify the key
name in the FieldExport resource. If this attribute is specified,
use this key name instead of the default.

Signed-off-by: Baiju Muthukadan baiju.m.mail@gmail.com

Issue #, if available: aws-controllers-k8s/community#1410

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

ack-bot · 2022-08-23T16:32:47Z

Hi @baijum. Thanks for your PR.

I'm waiting for a aws-controllers-k8s member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

FieldExport generates the key name with an output structure like `<namespace>.<FieldExport-resource-name>`. This default naming structure creates non-conflicting names as the keys. However, many applications expect short names as keys. This is important, especially when the Secret/ConfigMap is mounted as files; the file names are nothing but the key names. This PR adds an optional attribute (.spec.to.key) to specify the key name in the FieldExport resource. If this attribute is specified, use this key name instead of the default. Proposal: aws-controllers-k8s/community#1410 Signed-off-by: Baiju Muthukadan <baiju.m.mail@gmail.com>

jaypipes

@baijum cool stuff! couple things for you inline :)

jaypipes · 2022-08-23T18:07:27Z

apis/core/v1alpha1/field_export.go

@@ -24,6 +24,7 @@ type FieldExportTarget struct {
 	// Namespace is marked as optional, so we cannot compose `NamespacedName`
 	Namespace *string               `json:"namespace,omitempty"`
 	Kind      FieldExportOutputType `json:"kind"`
+	Key       *string               `json:"key,omitempty"`


Go ahead and add a docstring above here so that our API reference docs will include an explanation for the field.

Added docs. a974e46

jaypipes · 2022-08-23T18:07:58Z

pkg/runtime/field_export_reconciler.go

@@ -296,6 +296,9 @@ func (r *fieldExportReconciler) writeToConfigMap(
 ) error {
 	// Construct the data key
 	key := fmt.Sprintf("%s.%s", desired.Namespace, desired.Name)
+	if desired.Spec.To.Key != nil {
+		key = *desired.Spec.To.Key


What happens if the user enters an empty string?

I have changed the logic to consider empty strings. With an empty string value, the key will fall back to <namespace>.<FieldExport-resource-name>. a974e46

Signed-off-by: Baiju Muthukadan <baiju.m.mail@gmail.com>

a-hilaly · 2022-08-24T10:05:54Z

/ok-to-test

a-hilaly

Looks great! left one question

a-hilaly · 2022-08-24T10:06:30Z

pkg/runtime/field_export_reconciler.go

@@ -340,6 +343,9 @@ func (r *fieldExportReconciler) writeToSecret(
 ) error {
 	// Construct the data key
 	key := fmt.Sprintf("%s.%s", desired.Namespace, desired.Name)
+	if desired.Spec.To.Key != nil && strings.TrimSpace(*desired.Spec.To.Key) != "" {


Shall we handle cases where Spec.To is nil? to avoid nil panics?

Done. f6caece

Signed-off-by: Baiju Muthukadan <baiju.m.mail@gmail.com>

a-hilaly

Neat! 👍

baijum · 2022-08-30T16:16:49Z

Once this PR is merged. I am planning to write a blog. Here is the early draft: https://gist.github.com/baijum/96158408eaf544f692acfad42f2b49df

RedbackThomson

This is an awesome addition. It's something I considered in the original design, but left it out just because I thought it wasn't necessary for an initial release. Thank you!

/lgtm

ack-bot · 2022-08-30T19:38:28Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: A-Hilaly, baijum, RedbackThomson

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [A-Hilaly,RedbackThomson]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ack-bot requested review from RedbackThomson and vijtrip2 August 23, 2022 16:32

ack-bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 23, 2022

baijum force-pushed the key branch from 8ca1d3d to 96161c4 Compare August 23, 2022 16:33

jaypipes reviewed Aug 23, 2022

View reviewed changes

Fall back to default with empty string as key

a974e46

Signed-off-by: Baiju Muthukadan <baiju.m.mail@gmail.com>

baijum force-pushed the key branch from 0838098 to a974e46 Compare August 24, 2022 04:41

ack-bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 24, 2022

a-hilaly reviewed Aug 24, 2022

View reviewed changes

Check for nil

f6caece

Signed-off-by: Baiju Muthukadan <baiju.m.mail@gmail.com>

a-hilaly approved these changes Aug 24, 2022

View reviewed changes

ack-bot added the approved label Aug 24, 2022

RedbackThomson approved these changes Aug 30, 2022

View reviewed changes

ack-bot assigned RedbackThomson Aug 30, 2022

ack-bot added the lgtm Indicates that a PR is ready to be merged. label Aug 30, 2022

ack-bot merged commit f654031 into aws-controllers-k8s:main Aug 30, 2022

baijum mentioned this pull request Sep 2, 2022

Add optional key name for the FieldExport target aws-controllers-k8s/community#1410

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add optional key to the FieldExport target #100

Add optional key to the FieldExport target #100

baijum commented Aug 23, 2022 •

edited by a-hilaly

Loading

ack-bot commented Aug 23, 2022

jaypipes left a comment

jaypipes Aug 23, 2022

baijum Aug 24, 2022

jaypipes Aug 23, 2022

baijum Aug 24, 2022

a-hilaly commented Aug 24, 2022

a-hilaly left a comment

a-hilaly Aug 24, 2022

baijum Aug 24, 2022

a-hilaly left a comment

baijum commented Aug 30, 2022

RedbackThomson left a comment

ack-bot commented Aug 30, 2022

Add optional key to the FieldExport target #100

Add optional key to the FieldExport target #100

Conversation

baijum commented Aug 23, 2022 • edited by a-hilaly Loading

ack-bot commented Aug 23, 2022

jaypipes left a comment

Choose a reason for hiding this comment

jaypipes Aug 23, 2022

Choose a reason for hiding this comment

baijum Aug 24, 2022

Choose a reason for hiding this comment

jaypipes Aug 23, 2022

Choose a reason for hiding this comment

baijum Aug 24, 2022

Choose a reason for hiding this comment

a-hilaly commented Aug 24, 2022

a-hilaly left a comment

Choose a reason for hiding this comment

a-hilaly Aug 24, 2022

Choose a reason for hiding this comment

baijum Aug 24, 2022

Choose a reason for hiding this comment

a-hilaly left a comment

Choose a reason for hiding this comment

baijum commented Aug 30, 2022

RedbackThomson left a comment

Choose a reason for hiding this comment

ack-bot commented Aug 30, 2022

baijum commented Aug 23, 2022 •

edited by a-hilaly

Loading